<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pybindgen.cppclass</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pybindgen-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="pybindgen-module.html">Package&nbsp;pybindgen</a> ::
        Module&nbsp;cppclass
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="pybindgen.cppclass-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module cppclass</h1><p class="nomargin-top"><span class="codelink"><a href="pybindgen.cppclass-pysrc.html">source&nbsp;code</a></span></p>
<p>Wrap C++ classes and methods</p>

<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Classes</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.cppclass.MemoryPolicy-class.html" class="summary-name">MemoryPolicy</a><br />
      memory management policy for a C++ class or C/C++ struct
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.cppclass.ReferenceCountingPolicy-class.html" class="summary-name">ReferenceCountingPolicy</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.cppclass.ReferenceCountingMethodsPolicy-class.html" class="summary-name">ReferenceCountingMethodsPolicy</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.cppclass.ReferenceCountingFunctionsPolicy-class.html" class="summary-name">ReferenceCountingFunctionsPolicy</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.cppclass.FreeFunctionPolicy-class.html" class="summary-name">FreeFunctionPolicy</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.cppclass.CppHelperClass-class.html" class="summary-name">CppHelperClass</a><br />
      Generates code for a C++ proxy subclass that takes care of 
        forwarding virtual methods from C++ to Python.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.cppclass.CppClass-class.html" class="summary-name">CppClass</a><br />
      A CppClass object takes care of generating the code for wrapping a 
        C++ class
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Functions</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get_python_to_c_converter"></a><span class="summary-sig-name">get_python_to_c_converter</span>(<span class="summary-sig-arg">value</span>,
        <span class="summary-sig-arg">root_module</span>,
        <span class="summary-sig-arg">code_sink</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.cppclass-pysrc.html#get_python_to_c_converter">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_get_python_to_c-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_get_python_to_c-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_get_python_to_c" name="call_graph_for_get_python_to_c">
<area shape="rect" href="pybindgen.cppclass.CppClass-class.html#_generate_number_methods" title="CppClass._generate_number_methods()" alt="" coords="5,33,392,65"/>
<area shape="rect" href="pybindgen.cppclass-module.html#get_python_to_c_converter" title="get_python_to_c_converter()" alt="" coords="440,33,728,65"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassReturnValue-class.html#__init__" title="cppclass_typehandlers.CppClassReturnValue.__init__()" alt="" coords="785,5,1303,37"/>
<area shape="rect" href="pybindgen.module.Module-class.html#generate_python_to_c_type_converter" title="module.Module.generate_python_to_c_type_converter()" alt="" coords="776,61,1312,93"/>
</map>
  <img src="call_graph_for_get_python_to_c.gif" alt='' usemap="#call_graph_for_get_python_to_c" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get_c_to_python_converter"></a><span class="summary-sig-name">get_c_to_python_converter</span>(<span class="summary-sig-arg">value</span>,
        <span class="summary-sig-arg">root_module</span>,
        <span class="summary-sig-arg">code_sink</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.cppclass-pysrc.html#get_c_to_python_converter">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_get_c_to_python-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_get_c_to_python-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_get_c_to_python" name="call_graph_for_get_c_to_python">
<area shape="rect" href="pybindgen.cppclass.CppClass-class.html#_generate_number_methods" title="CppClass._generate_number_methods()" alt="" coords="5,33,392,65"/>
<area shape="rect" href="pybindgen.cppclass-module.html#get_c_to_python_converter" title="get_c_to_python_converter()" alt="" coords="440,33,728,65"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassReturnValue-class.html#__init__" title="cppclass_typehandlers.CppClassReturnValue.__init__()" alt="" coords="785,5,1303,37"/>
<area shape="rect" href="pybindgen.module.Module-class.html#generate_c_to_python_type_converter" title="module.Module.generate_c_to_python_type_converter()" alt="" coords="776,61,1312,93"/>
</map>
  <img src="call_graph_for_get_c_to_python.gif" alt='' usemap="#call_graph_for_get_c_to_python" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pybindgen.cppclass-module.html#default_instance_creation_function" class="summary-sig-name">default_instance_creation_function</a>(<span class="summary-sig-arg">cpp_class</span>,
        <span class="summary-sig-arg">code_block</span>,
        <span class="summary-sig-arg">lvalue</span>,
        <span class="summary-sig-arg">parameters</span>,
        <span class="summary-sig-arg">construct_type_name</span>)</span><br />
      Default &quot;instance creation function&quot;; it is called whenever
      a new C++ class instance needs to be created; this default 
      implementation uses a standard C++ new allocator.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.cppclass-pysrc.html#default_instance_creation_function">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_default_instanc-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_default_instanc-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_default_instanc" name="call_graph_for_default_instanc">
<area shape="rect" href="pybindgen.cppclass.CppClass-class.html#write_create_instance" title="CppClass.write_create_instance()" alt="" coords="5,5,333,37"/>
<area shape="rect" href="pybindgen.cppclass-module.html#default_instance_creation_function" title="default_instance_creation_function()" alt="" coords="383,5,737,37"/>
<area shape="rect" href="pybindgen.typehandlers.base.CodeBlock-class.html#write_code" title="typehandlers.base.CodeBlock.write_code()" alt="" coords="788,5,1199,37"/>
</map>
  <img src="call_graph_for_default_instanc.gif" alt='' usemap="#call_graph_for_default_instanc" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Variables</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'pybindgen'"><code class="variable-quote">'</code><code class="variable-string">pybindgen</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Function Details</span></td>
</tr>
</table>
<a name="default_instance_creation_function"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">default_instance_creation_function</span>(<span class="sig-arg">cpp_class</span>,
        <span class="sig-arg">code_block</span>,
        <span class="sig-arg">lvalue</span>,
        <span class="sig-arg">parameters</span>,
        <span class="sig-arg">construct_type_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pybindgen.cppclass-pysrc.html#default_instance_creation_function">source&nbsp;code</a></span>&nbsp;
    <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_default_instanc-div');return false;">call&nbsp;graph</a></span>&nbsp;</td>
  </tr></table>
  <div style="display:none" id="call_graph_for_default_instanc-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_default_instanc" name="call_graph_for_default_instanc">
<area shape="rect" href="pybindgen.cppclass.CppClass-class.html#write_create_instance" title="CppClass.write_create_instance()" alt="" coords="5,5,333,37"/>
<area shape="rect" href="pybindgen.cppclass-module.html#default_instance_creation_function" title="default_instance_creation_function()" alt="" coords="383,5,737,37"/>
<area shape="rect" href="pybindgen.typehandlers.base.CodeBlock-class.html#write_code" title="typehandlers.base.CodeBlock.write_code()" alt="" coords="788,5,1199,37"/>
</map>
  <img src="call_graph_for_default_instanc.gif" alt='' usemap="#call_graph_for_default_instanc" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

  <p>Default &quot;instance creation function&quot;; it is called whenever 
  a new C++ class instance needs to be created; this default implementation
  uses a standard C++ new allocator.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>cpp_class</code></strong> - the CppClass object whose instance is to be created</li>
        <li><strong class="pname"><code>code_block</code></strong> - CodeBlock object on which the instance creation code should be 
          generated</li>
        <li><strong class="pname"><code>lvalue</code></strong> - lvalue expression that should hold the result in the end</li>
        <li><strong class="pname"><code>parameters</code></strong> - stringified list of parameters</li>
        <li><strong class="pname"><code>construct_type_name</code></strong> - actual name of type to be constructed (it is not always the class
          name, sometimes it's the python helper class)</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pybindgen-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Jul 12 17:23:07 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
